﻿using System;
using System.Text;
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements.  See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership.  The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License.  You may obtain a copy of the License at
*
*   http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied.  See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/* Generated By:JavaCC: Do not edit this line. ParseException.java Version 3.0 */
namespace Velocity4Net.Runtime.Parser
{

    /**
     * This exception is thrown when parse errors are encountered.
     * It is intended to be caught and typically will be rethrown
     * as a ParseErrorException.
     *
     * <p>You can explicitly create objects of this exception type by
     * calling the method generateParseException in the generated
     * parser.
     *
     * You can modify this class to customize your error reporting
     * mechanisms so long as you retain the public fields.
     */
    public class ParseException : Exception
    {

        private const long serialVersionUID = -309603325673449381L;

        /**
         * <p>This constructor is used by the method "generateParseException"
         * in the generated parser.  Calling this constructor generates
         * a new object of this type with the fields "currentToken",
         * "expectedTokenSequences", and "tokenImage" set.  The bool
         * flag "specialConstructor" is also set to true to indicate that
         * this constructor was used to create this object.
         * This constructor calls its super class with the empty string
         * to force the "toString" method of parent class "Throwable" to
         * print the error message in the form:</p>
         * <pre>
         *     ParseException: &lt;result of getMessage&gt;
         * </pre>
         * @param currentTokenVal
         * @param expectedTokenSequencesVal
         * @param tokenImageVal
         */
        public ParseException(Token currentTokenVal,
                              int[][] expectedTokenSequencesVal,
                              String[] tokenImageVal
        ) : base("")
        {
            specialConstructor = true;
            currentToken = currentTokenVal;
            expectedTokenSequences = expectedTokenSequencesVal;
            tokenImage = tokenImageVal;
        }

        /**
         * The following constructors are for use by you for whatever
         * purpose you can think of.  Constructing the exception in this
         * manner makes the exception behave in the normal way - i.e., as
         * documented in the class "Throwable".  The fields "errorToken",
         * "expectedTokenSequences", and "tokenImage" do not contain
         * relevant information.  The JavaCC generated code does not use
         * these constructors.
         */
        public ParseException() : base()
        {
            specialConstructor = false;
        }

        /**
         * The following constructors are for use by you for whatever
         * purpose you can think of.  Constructing the exception in this
         * manner makes the exception behave in the normal way - i.e., as
         * documented in the class "Throwable".  The fields "errorToken",
         * "expectedTokenSequences", and "tokenImage" do not contain
         * relevant information.  The JavaCC generated code does not use
         * these constructors.
         * @param message
         */
        public ParseException(String message) : base(message)
        {
            specialConstructor = false;
        }

        /**
         * This variable determines which constructor was used to create
         * this object and thereby affects the semantics of the
         * "getMessage" method (see below).
         */
        protected bool specialConstructor;

        /**
         * This is the last token that has been consumed successfully.  If
         * this object has been created due to a parse error, the token
         * followng this token will (therefore) be the first error token.
         */
        public Token currentToken;

        /**
         * Each entry in this array is an array of integers.  Each array
         * of integers represents a sequence of tokens (by their ordinal
         * values) that is expected at this point of the parse.
         */
        public int[][] expectedTokenSequences;

        /**
         * This is a reference to the "tokenImage" array of the generated
         * parser within which the parse error occurred.  This array is
         * defined in the generated ...Constants interface.
         */
        public String[] tokenImage;

        /**
         * This method has the standard behavior when this object has been
         * created using the standard constructors.  Otherwise, it uses
         * "currentToken" and "expectedTokenSequences" to generate a parse
         * error message and returns it.  If this object has been created
         * due to a parse error, and you do not catch it (it gets thrown
         * from the parser), then this method is called during the printing
         * of the final stack trace, and hence the correct error message
         * gets displayed.
         * @return message
         */
        public String getMessage()
        {
            if (!specialConstructor)
            {
                return base.Message;
            }
            String expected = "";
            int maxSize = 0;
            foreach (int[] expectedTokenSequence in expectedTokenSequences)
            {
                if (maxSize < expectedTokenSequence.Length)
                {
                    maxSize = expectedTokenSequence.Length;
                }
                for (int j = 0; j < expectedTokenSequence.Length; j++)
                {
                    expected += tokenImage[expectedTokenSequence[j]] + " ";
                }
                if (expectedTokenSequence[expectedTokenSequence.Length - 1] != 0)
                {
                    expected += "...";
                }
                expected += eol + "    ";
            }
            String retval = "Encountered \"";
            Token tok = currentToken.next;
            for (int i = 0; i < maxSize; i++)
            {
                if (i != 0) retval += " ";
                if (tok.kind == 0)
                {
                    retval += tokenImage[0];
                    break;
                }
                retval += add_escapes(tok.image);
                tok = tok.next;
            }
            retval += "\" at line " + currentToken.next.beginLine + ", column " + currentToken.next.beginColumn;
            retval += "." + eol;
            if (expectedTokenSequences.Length == 1)
            {
                retval += "Was expecting:" + eol + "    ";
            }
            else
            {
                retval += "Was expecting one of:" + eol + "    ";
            }
            retval += expected;
            return retval;
        }

        /**
         * The end of line string for this machine.
         */
        protected String eol = Environment.NewLine;

        /**
         * Used to convert raw characters to their escaped version
         * when these raw version cannot be used as part of an ASCII
         * string literal.
         * @param str raw characters
         * @return escaped string
         */
        protected String add_escapes(String str)
        {
            StringBuilder retval = new StringBuilder();
            char ch;
            for (int i = 0; i < str.Length; i++)
            {
                switch (str[i])
                {
                    case (char)0:
                        continue;
                    case '\b':
                        retval.Append("\\b");
                        continue;
                    case '\t':
                        retval.Append("\\t");
                        continue;
                    case '\n':
                        retval.Append("\\n");
                        continue;
                    case '\f':
                        retval.Append("\\f");
                        continue;
                    case '\r':
                        retval.Append("\\r");
                        continue;
                    case '\"':
                        retval.Append("\\\"");
                        continue;
                    case '\'':
                        retval.Append("\\\'");
                        continue;
                    case '\\':
                        retval.Append("\\\\");
                        continue;
                    default:
                        if ((ch = str[i]) < 0x20 || ch > 0x7e)
                        {
                            String s = "0000" + string.Format("{0:x}", ch);
                            retval.Append("\\u").Append(s.Substring(s.Length - 4, s.Length - 4));
                        }
                        else
                        {
                            retval.Append(ch);
                        }
                        break;
                }
            }
            return retval.ToString();
        }

    }
}